/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.wse;

import cgl.narada.wsinfra.schemas.addressing.ActionDocument;
/**
    This class provides a one-stop for all the URIs related to WS-Addressing
    Action URIs used within WS-Eventing. This eliminates the need to hard-code
    this in several places. Furthermore, if the spec changes the impact of this
    change will be felt at far fewer places.


    @author Shrideep Pallickara
    $Date: 2004/12/16 21:26:39 $
    $Revision: 1.3 $
*/


public class WseActions {
  private static final WseActions instance = new WseActions();

  private static final String wseSubscribe =
  "http://schemas.xmlsoap.org/ws/2004/08/eventing/Subscribe";

  private static final String wseSubscribeResponse =
  "http://schemas.xmlsoap.org/ws/2004/08/eventing/SubscribeResponse";

  private static final String wseRenew =
  "http://schemas.xmlsoap.org/ws/2004/08/eventing/Renew";

  private static final String wseRenewResponse =
  "http://schemas.xmlsoap.org/ws/2004/08/eventing/RenewResponse";

  private static final String wseGetStatus =
  "http://schemas.xmlsoap.org/ws/2004/08/eventing/GetStatus";

  private static final String wseGetStatusResponse =
  "http://schemas.xmlsoap.org/ws/2004/08/eventing/GetStatusResponse";

  private static final String wseUnsubscribe =
  "http://schemas.xmlsoap.org/ws/2004/08/eventing/Unsubscribe";

  private static final String wseUnsubscribeResponse =
  "http://schemas.xmlsoap.org/ws/2004/08/eventing/UnsubscribeResponse";

  private static final String wseSubscriptionEnd =
  "http://schemas.xmlsoap.org/ws/2004/08/eventing/SubscriptionEnd";

  private ActionDocument wseSubscribeAction = null;
  private ActionDocument  wseSubscribeResponseAction = null;
  private ActionDocument wseRenewAction = null;
  private ActionDocument wseRenewResponseAction = null;
  private ActionDocument wseGetStatusAction = null;
  private ActionDocument wseGetStatusResponseAction = null;
  private ActionDocument wseUnsubscribeAction = null;
  private ActionDocument wseUnsubscribeResponseAction = null;
  private ActionDocument wseSubscriptionEndAction = null;


  private WseActions() {}


  /** Retrieves the instance */
  public static WseActions getInstance() {
    return instance;
  }


  /** Retrieve the String action associated with the exchange */
  public String getSubscribe() {
    return wseSubscribe;
  }

  /** Retrieve the String action associated with the exchange */
  public String getSubscribeResponse() {
    return wseSubscribeResponse;
  }


  /** Retrieve the String action associated with the exchange */
  public String getRenew() {
    return wseRenew;
  }


  /** Retrieve the String action associated with the exchange */
  public String getRenewResponse() {
    return wseRenewResponse;
  }


  /** Retrieve the String action associated with the exchange */
  public String getGetStatus() {
    return wseGetStatus;
  }


  /** Retrieve the String action associated with the exchange */
  public String getGetStatusResponse() {
    return wseGetStatusResponse;
  }


  /** Retrieve the String action associated with the exchange */
  public String getUnsubscribe() {
    return wseUnsubscribe;
  }


  /** Retrieve the String action associated with the exchange */
  public String getUnsubscribeResponse() {
    return wseUnsubscribeResponse;
  }


  /** Retrieve the String action associated with the exchange */
  public String getSubscriptionEnd() {
    return wseSubscriptionEnd;
  }


  /** Check to see if this is one of the registered WS-Eventing actions */
  public boolean isValidEventingAction(String actionToCheck) {

    if (actionToCheck.equals(wseSubscribe) ||
	actionToCheck.equals(wseSubscribeResponse) ||
	actionToCheck.equals(wseRenew) ||
	actionToCheck.equals(wseRenewResponse) ||
	actionToCheck.equals(wseGetStatus) ||
	actionToCheck.equals(wseGetStatusResponse) ||
	actionToCheck.equals(wseUnsubscribe) ||
	actionToCheck.equals(wseUnsubscribeResponse) ||
	actionToCheck.equals(wseSubscriptionEnd) ) {
      return true;
    }
    return false;
  }



  /** Retrieve the ActionDocument associated with the exchange */
  public ActionDocument getSubscribeAction() {
    if (wseSubscribeAction == null) {
      wseSubscribeAction = prepareActionDocument(wseSubscribe);
    }
    return wseSubscribeAction;
  }

  /** Retrieve the ActionDocument associated with the exchange */
  public ActionDocument getSubscribeResponseAction() {
    if (wseSubscribeResponseAction == null) {
      wseSubscribeResponseAction = prepareActionDocument(wseSubscribeResponse);
    }

    return wseSubscribeResponseAction;
  }


  /** Retrieve the ActionDocument associated with the exchange */
  public ActionDocument getRenewAction() {
    if (wseRenewAction == null) {
      wseRenewAction = prepareActionDocument(wseRenew);
    }

    return wseRenewAction;
  }


  /** Retrieve the ActionDocument associated with the exchange */
  public ActionDocument getRenewResponseAction() {
    if (wseRenewResponseAction == null) {
      wseRenewResponseAction = prepareActionDocument(wseRenewResponse);
    }
    return wseRenewResponseAction;
  }


  /** Retrieve the ActionDocument associated with the exchange */
  public ActionDocument getGetStatusAction() {
    if (wseGetStatusAction == null) {
      wseGetStatusAction = prepareActionDocument(wseGetStatus);
    }
    return wseGetStatusAction;
  }


  /** Retrieve the ActionDocument associated with the exchange */
  public ActionDocument getGetStatusResponseAction() {
    if (wseGetStatusResponseAction == null) {
      wseGetStatusResponseAction = prepareActionDocument(wseGetStatusResponse);
    }
    return wseGetStatusResponseAction;
  }


  /** Retrieve the ActionDocument associated with the exchange */
  public ActionDocument getUnsubscribeAction() {
    if (wseUnsubscribeAction == null) {
      wseUnsubscribeAction = prepareActionDocument(wseUnsubscribe);
    }
    return wseUnsubscribeAction;
  }


  /** Retrieve the ActionDocument associated with the exchange */
  public ActionDocument getUnsubscribeResponseAction() {
    if (wseUnsubscribeResponseAction == null) {
      wseUnsubscribeResponseAction =
	prepareActionDocument(wseUnsubscribeResponse);
    }
    return wseUnsubscribeResponseAction;
  }


  /** Retrieve the ActionDocument associated with the exchange */
  public ActionDocument getSubscriptionEndAction() {
    if (wseSubscriptionEndAction == null) {
      wseSubscriptionEndAction = prepareActionDocument(wseSubscriptionEnd);
    }
    return wseSubscriptionEndAction;
  }


  private ActionDocument prepareActionDocument(String wsaAction) {
    ActionDocument actionDocument = ActionDocument.Factory.newInstance();
    actionDocument.addNewAction().setStringValue(wsaAction);
    return actionDocument;
  }

}





